Documentation for Users  2.0.2
Perception Toolbox for Virtual Reality (PTVR) Manual
VisualScene Class Reference
+ Inheritance diagram for VisualScene:

Public Member Functions

def __init__ (self, trial=-1, background_color=color.RGBColor(0.6, 0.6, 0.6, 1), are_both_hand_controllers_visible=False, is_left_hand_controller_visible=False, is_right_hand_controller_visible=False, is_left_hand_visible=False, is_right_hand_visible=False, skybox="", global_lights_intensity=1, side_view_on_pc=False, augmented_vision=False)
 
def place (self, visual_object, the_3D_world)
 
def placeUI (self, o)
 
def to_json (self)
 
def set_augmented_vision (self)
 
def write (self, fp)
 
def AddInteraction (self, events=[], callbacks=[])
 
def AddPointingCursor (self, pointingCursor)
 
def place_contingent_cursor (self, pointingCursor)
 
def place_pointing_laser (self, pointingCursor)
 
def fill_in_results_file_column (self, column_name, value)
 

Data Fields

 objects
 
 UIobjects
 
 type
 
 on_loaded_event
 
 augmented_vision
 
 isLeftControllerVisibility
 
 isRightControllerVisibility
 
 isLeftHandVisibility
 
 isRightHandVisibility
 
 leftBackgroundColor
 
 rightBackgroundColor
 
 interaction
 
 pointingCursors
 
 id
 
 trial
 
 origin
 
 originIsSet
 
 skybox
 
 global_lights_intensity
 
 side_view_on_pc
 
 fillInResultsFileColumnString
 

Private Member Functions

def _pickle_object (self, o, pos, rot)
 

Detailed Description

Parameters
----------
trial :  The default is -1.
background_color :The default is color.RGBColor(0.6, 0.6, 0.6, 1).

skybox : "Night", "BrightMorning", "Cloudy", "Afternoon", "Sunset", "MilkyWay"
    DESCRIPTION. 
    The default is "".

global_lights_intensity : number from zero to undefined upper limit.
    Six sources of light are placed above the XZ plane to induce
    some shading of the objects in a scene.
    It is independent of whether 'skybox' has been set to one of its possible arguments.
    The default is 1.

side_view_on_pc : 
    DESCRIPTION. When True, the PTVR window (on your PC) will show you 
    a "side view". 
    This is as if the PTVR window showed the view from a camera looking
    laterally at your subject (at its headset actually). 
    You can rotate this view with your mouse.
    This is convenient for didactic purposes.
    The default is False.

Returns
-------
None.

Definition at line 106 of file Scenes.py.


The documentation for this class was generated from the following file: